Fix outdated links by beckykd · Pull Request #4506 · Qiskit/documentation

beckykd · 2026-01-09T22:00:43Z

Related to #4336

review-notebook-app · 2026-01-09T22:00:48Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

qiskit-bot · 2026-01-09T22:01:12Z

One or more of the following people are relevant to this code:

scripts/js/lib/links/ignores.ts

frankharkins

Thank you!

For the links in the API docs, we'll need to add the redirects to scripts/config/external-redirects.ts, otherwise these changes will be discarded when we next regenerate the docs from source.

The format is:

"old":
  "new",

E.g.

documentation/scripts/config/external-redirects.ts

Lines 38 to 39 in 2140419

    
           "https://aip.scitation.org/doi/10.1063/1.5141835": 
        
             "https://pubs.aip.org/aip/jcp/article/152/12/124107/953761/Quantum-orbital-optimized-unitary-coupled-cluster",

Co-authored-by: Frank Harkins <[email protected]>

beckykd · 2026-01-12T15:06:27Z

we'll need to add the redirects

Even though the changes will be made in the API docs themselves?

frankharkins · 2026-01-12T15:34:41Z

Even though the changes will be made in the API docs themselves?

Yep: We store the original API docs HTML in Box and sometimes re-run the HTML -> markdown pipeline to fix bugs. When this happens, your fixes will be overwritten by the pipeline with the original links. The external-redirects.ts tells the pipeline to do the same link substitution that you've done in this PR.

beckykd · 2026-01-15T20:42:06Z

@frankharkins what should we do about links that are broken in historical API documents but don't exist in more recent documents? For example, qaiskit-ibm-runtime/0.40/qiskit-runtime-service links to https://auth.quantum.ibm.com/api. That API no longer exists and the link was just deleted from the later versions.

beckykd · 2026-01-15T21:33:08Z

These are the changes being made in the API file:

https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/backend_configuration_schema.json -> https://quantum.cloud.ibm.com/docs/api/qiskit-runtime-rest/tags/backends#tags__backends__operations__get_backend_configuration

https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/backend_properties_schema.json -> https://quantum.cloud.ibm.com/docs/api/qiskit-runtime-rest/tags/backends#tags__backends__operations__get_backend_configuration

https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/default_pulse_configuration_schema.json -> DELETED

arnaucasau

Thanks for working on this, Becky!!

scripts/js/lib/links/ignores.ts

arnaucasau · 2026-02-03T09:19:57Z

docs/api/qiskit-ibm-runtime/release-notes.mdx

 *   The `channel_strategy` parameter in `QiskitRuntimeService` has been removed. To continue using Q-CTRL in your workflow, please explore the following options:

    > *   If your organization has an existing IBM Quantum Premium Plan instance: migrate to the Q-CTRL Performance Management Function, found in the [Qiskit Functions Catalog](https://quantum.ibm.com/functions).
-    > *   To continue using Qiskit Runtime with IBM Cloud: migrate to Q-CTRL Fire Opal, the same performance management product accessible directly through Q-CTRL. You can [connect your IBM Cloud API key and Qiskit Runtime CRN](https://docs.q-ctrl.com/fire-opal/discover/hardware-providers/how-to-authenticate-with-ibm-credentials) to Fire Opal. ([1966](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1966))


This link needs to be fixed in the runtime repo (main branch and stable/0.45):

https://github.com/Qiskit/qiskit-ibm-runtime/blob/ce9f35518e35f6ca18ed85471b993ee6326b1f9c/release-notes/0.32.0.rst?plain=1#L47

https://github.com/Qiskit/qiskit-ibm-runtime/blob/ce9f35518e35f6ca18ed85471b993ee6326b1f9c/release-notes/0.30.0.rst?plain=1#L18

This link needs to be fixed in the runtime repo

Jessie said to just ignore it, since it's in a really old release note. I'll add to the Ignore file.

Unfortunately, we can't ignore the issue because it's in the release notes. Our script regenerates the whole release note file with each version, so we would revert the change in the future if it's not fixed.

We can only ignore issues with historical versions if it's in a page different than the release notes :(

In my opinion we should fix it on the runtime repo and remove the redirect in external-redirects.ts given that it won't be necessary anymore

docs/api/qiskit/0.46/qiskit.algorithms.optimizers.ISRES.mdx

frankharkins · 2026-02-03T10:09:58Z

@frankharkins what should we do about links that are broken in historical API documents but don't exist in more recent documents? For example, qaiskit-ibm-runtime/0.40/qiskit-runtime-service links to https://auth.quantum.ibm.com/api. That API no longer exists and the link was just deleted from the later versions.

I think if a link has no replacement, it's OK for it to be broken in a historical version. These are archives after all and it might even be helpful for a user to know that the API isn't available any more.

Maybe just update the comment to explain we're not going to fix them.

beckykd · 2026-02-03T22:47:17Z

These are the changes being made in the API file:

I updated the comment in the Ignore.ts file to explain why we're leaving the links that don't have a replacement as-is in the old API docs. I also added the redirects listed to the external-redirects file.

scripts/config/external-redirects.ts

arnaucasau · 2026-02-04T15:31:55Z

scripts/config/external-redirects.ts

+  "https://docs.q-ctrl.com/fire-opal/discover/hardware-providers/how-to-authenticate-with-ibm-credentials":
+    "https://docs.q-ctrl.com/fire-opal/discover/hardware-providers/how-to-migrate-from-performance-management-on-ibm-cloud",


We can remove it if we do https://github.com/Qiskit/documentation/pull/4506/changes#r2758072445

arnaucasau · 2026-02-04T15:33:50Z

scripts/js/lib/links/ignores.ts

+  // but they will never be fixed in the old API docs.  We decided to leave these links as-is for archival purposes.
  "https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/backend_status_schema.json",
  "https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/default_pulse_configuration_schema.json",
+  "https://docs.q-ctrl.com/fire-opal/discover/hardware-providers/how-to-authenticate-with-ibm-credentials",


Do we need this link to be ignored now? I think we can remove it if it only appears in the qiskit-ibm-runtime release notes

Fix outdated links

04a7743

github-project-automation bot added this to Docs Planning Jan 9, 2026

github-actions bot deployed to pr_preview January 9, 2026 22:01 View deployment

frankharkins reviewed Jan 12, 2026

View reviewed changes

scripts/js/lib/links/ignores.ts Show resolved Hide resolved

frankharkins requested changes Jan 12, 2026

View reviewed changes

beckykd and others added 2 commits January 12, 2026 09:04

Merge branch 'main' into bd-update-external-links

144f166

Update scripts/js/lib/links/ignores.ts

72f20c6

Co-authored-by: Frank Harkins <[email protected]>

github-actions bot deployed to pr_preview January 12, 2026 15:05 View deployment

remove the links that were fixed

d6945e1

github-actions bot deployed to pr_preview January 12, 2026 15:12 View deployment

beckykd mentioned this pull request Jan 12, 2026

Fix formatting #4511

Closed

Merge branch 'main' into bd-update-external-links

0e56e46

beckykd requested a review from frankharkins February 2, 2026 16:46

github-actions bot deployed to pr_preview February 2, 2026 16:46 View deployment

arnaucasau reviewed Feb 3, 2026

View reviewed changes

add redirects

15cd726

github-actions bot deployed to pr_preview February 3, 2026 23:04 View deployment

Add one more link to ignore

732ca77

github-actions bot deployed to pr_preview February 4, 2026 15:20 View deployment

arnaucasau reviewed Feb 4, 2026

View reviewed changes

It's being ignored; not redirected

dbf78c3

github-actions bot deployed to pr_preview February 4, 2026 20:27 View deployment

remove from redirects because its in Ignore

76a3849

github-actions bot deployed to pr_preview February 4, 2026 20:32 View deployment

don't need this

494f37d

github-actions bot deployed to pr_preview February 4, 2026 21:42 View deployment

	"https://aip.scitation.org/doi/10.1063/1.5141835":
	"https://pubs.aip.org/aip/jcp/article/152/12/124107/953761/Quantum-orbital-optimized-unitary-coupled-cluster",

		"https://docs.q-ctrl.com/fire-opal/discover/hardware-providers/how-to-authenticate-with-ibm-credentials":
		"https://docs.q-ctrl.com/fire-opal/discover/hardware-providers/how-to-migrate-from-performance-management-on-ibm-cloud",

Conversation

beckykd commented Jan 9, 2026

Uh oh!

review-notebook-app bot commented Jan 9, 2026

Uh oh!

qiskit-bot commented Jan 9, 2026

Uh oh!

Uh oh!

frankharkins left a comment

Choose a reason for hiding this comment

Uh oh!

beckykd commented Jan 12, 2026

Uh oh!

frankharkins commented Jan 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

beckykd commented Jan 15, 2026

Uh oh!

beckykd commented Jan 15, 2026

Uh oh!

arnaucasau left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

arnaucasau Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

beckykd Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

arnaucasau Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

arnaucasau Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

beckykd Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

frankharkins commented Feb 3, 2026

Uh oh!

beckykd commented Feb 3, 2026

Uh oh!

Uh oh!

Uh oh!

arnaucasau Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

arnaucasau Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

frankharkins commented Jan 12, 2026 •

edited

Loading

arnaucasau Feb 4, 2026 •

edited

Loading